kanzi::AnimationPlayer Class Reference

Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player. More...

#include <kanzi/ui/node_component/animation/animation_player.hpp>

Inheritance diagram for kanzi::AnimationPlayer:

Classes
class	CompletedMessageArguments
	Message arguments for the Completed message. More...
class	PauseMessageArguments
	Message arguments for the Pause message. More...
class	PlayMessageArguments
	Message arguments for the Play message. More...
class	ResumeMessageArguments
	Message arguments for the Resume message. More...
class	StartedMessageArguments
	Message arguments for the Started message. More...
class	StopMessageArguments
	Message arguments for the Stop message. More...
class	StoppedMessageArguments
	Message arguments for the Stopped message. More...

Public Member Functions
float	getDurationScale () const
	Gets the value of the DurationScaleProperty property.
Timeline::DirectionBehavior	getPlaybackMode () const
	Gets the value of the PlaybackModeProperty property.
int	getRepeatCount () const
	Gets the value of the RepeatCountProperty property.
TimelineSharedPtr	getTimeline () const
	Gets the animation timeline from the TimelineProperty property of an Animation Player.
TimelinePlaybackSharedPtr	getTimelinePlayback () const
	Gets the timeline playback made for the timeline.
bool	isAutoplayEnabled () const
	Gets the value of the AutoplayEnabledProperty property.
bool	isRelativePlayback () const
	Gets the value of the RelativePlaybackProperty property.
bool	isRestoreOriginalValuesAfterPlayback () const
	Gets the values of the RestoreOriginalValuesAfterPlaybackProperty property.
void	pause ()
	Pauses running playback. If the playback is already paused or stopped, does nothing.
void	resume ()
	Resumes playing a paused timeline. If the playback is stopped, starts playing the timeline from the beginning.
void	setAutoplayEnabled (bool enabled)
	Sets the value of the AutoplayEnabledProperty property of an Animation Player.
void	setDurationScale (float durationScale)
	Sets the value of the DurationScaleProperty property.
void	setPlaybackMode (Timeline::DirectionBehavior mode)
	Sets the value of the PlaybackModeProperty property.
void	setRelativePlayback (bool relativePlayback)
	Sets the value of the RelativePlaybackProperty property.
void	setRepeatCount (int repeatCount)
	Sets the value of the RepeatCountProperty property.
void	setRestoreOriginalValuesAfterPlayback (bool restore)
	Sets the values of the RestoreOriginalValuesAfterPlaybackProperty property.
void	setTimeline (TimelineSharedPtr animationTimeline)
	Sets the TimelineProperty property of an Animation Player to the animation timeline that you pass in this method.
void	start (Timeline::DirectionBehavior direction, float durationScale, unsigned int repeatCount)
	Starts a new playback from the state of any animation player.
void	stop ()
	Stops running or paused playback.
Public Member Functions inherited from kanzi::NodeComponent
void	attach (NodeWeakPtr node)
	Attaches node component to node.
void	detach ()
	Detaches node component from the node it was attached to.
string	getName () const
	Gets the name of node component.
NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node.
State	getState () const
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.
bool	isAttached () const
	Indicates whether node component is attached to a node.
bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node.
bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached.
bool	isDetached () const
	Indicates whether node component is detached from any node.
bool	isDetaching () const
	Indicates whether node component currently detaching from the node.
bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached.
void	setName (string_view name)
	Sets the name of node component.
	~NodeComponent () override
	Destructor.
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.
void	applyObjectStyles ()
	Apply all styles for an object node.
Domain *	getDomain () const
	Returns the domain the object belongs to.
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.
	~Object () override
Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.
virtual	~MetaObject ()
Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.
	PropertyObject ()
void	removeKzbProperties ()
	Remove all KZB properties.
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.
template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
virtual	~PropertyObject ()

Static Public Member Functions
static AnimationPlayerSharedPtr	create (Domain *domain, string_view name)
	Creates animation player.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns PropertyType editor info of animation player.
Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Attributes
static PropertyType< bool >	AutoplayEnabledProperty
	Sets whether an Animation Player starts the playback of its animation timeline immediately after the player is attached to a node which is attached to the node tree.
static MessageType< CompletedMessageArguments >	CompletedMessage
	Completed message.
static PropertyType< float >	DurationScaleProperty
	Sets the amount by which the duration of an animation timeline is scaled during its playback.
static MessageType< PauseMessageArguments >	PauseMessage
	Pause message.
static PropertyType< KzuTimeLineEntryPlaybackMode >	PlaybackModeProperty
	Sets the mode of an animation timeline playback to either:
static MessageType< PlayMessageArguments >	PlayMessage
	Play message.
static PropertyType< bool >	RelativePlaybackProperty
	Sets whether an Animation Player plays animation timelines in a relative manner by adding the animated value to the target property value instead of replacing the property value.
static PropertyType< int >	RepeatCountProperty
	Sets how many times an animation timeline is played during its playback.
static PropertyType< bool >	RestoreOriginalValuesAfterPlaybackProperty
	Sets whether animated properties return to their initial values after the playback of an animation timeline ends.
static MessageType< ResumeMessageArguments >	ResumeMessage
	Resume message.
static MessageType< StartedMessageArguments >	StartedMessage
	Started message.
static MessageType< StopMessageArguments >	StopMessage
	Stop message.
static MessageType< StoppedMessageArguments >	StoppedMessage
	Stopped message.
static PropertyType< ResourceSharedPtr >	TimelineProperty
	Sets the animation timeline that an Animation Player plays after you attach it.
Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string >	NameProperty
	Name property specifies the name of node component.

Protected Member Functions
	AnimationPlayer (Domain *domain, string_view name)
	Constructor.
void	attachOverride () override
	NodeComponent::attachOverride() implementation.
void	detachOverride () override
	NodeComponent::detachOverride() implementation.
void	onPlaybackFinished (TimelinePlayback &timelinePlayback)
	Handler for finish timeline playback.
void	pauseMessageHandler (PauseMessageArguments &messageArguments)
	Message handler for the PauseMessage message.
void	playMessageHandler (PlayMessageArguments &messageArguments)
	Message handler for the PlayMessage message.
void	resumeMessageHandler (ResumeMessageArguments &messageArguments)
	Message handler for the ResumeMessage message.
void	stopMessageHandler (StopMessageArguments &messageArguments)
	Message handler for the StopMessage message.
Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name.
template<typename TMessageType >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name.
void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component.
template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component.
	NodeComponent (Domain *domain, string_view name)
	Constructor.
void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function.
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()
	MetaObject ()
Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source.
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.
virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source.
void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Additional Inherited Members
Public Types inherited from kanzi::NodeComponent
using	NodeComponentMessageArguments
	Legacy name for NodeComponentTargetMessageArguments.
enum	State { StateDetached , StateDetaching , StateAttaching , StateAttached }
	State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.
Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void	nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages.
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player.

Kanzi resolves paths to animated nodes relative to the node where you attach an Animation Player.

To control the playback of an Animation Player, send these messages to the node where you attached the Animation Player:

• PlayMessage to start an animation timeline.
• PauseMessage to pause a running animation timeline.
• ResumeMessage to resume a paused or stopped animation timeline.
• StopMessage to stop a running or paused animation timeline.

By default, an Animation Player does not start playback until you send the PlayMessage message to the node. To set an Animation Player to start the playback when you attach the Animation Player to a node, enable the AutoplayEnabledProperty property.

When you start the playback of an Animation Player by sending to it the PlayMessage or ResumeMessage message, or if the AutoplayEnabledProperty property is enabled, the player adds its timeline as a child to a parallel timeline and applies all playback settings from its PlaybackModeProperty, DurationScaleProperty and RepeatCountProperty properties to it. If you start the playback by sending a PlayMessage message with playback arguments, the player adds its parallel timeline as a child to yet another parallel timeline and applies playback settings from the PlayMessageArguments to it.

See also

PropertyDrivenAnimationPlayer, PropertyTargetInterpolator

Examples

To create animation player and set timeline:

        // Create animation player.
        AnimationPlayerSharedPtr animationPlayer = AnimationPlayer::create(domain, "player");
        // Set timeline.
        animationPlayer->setTimeline(timeline);

To attach animation player to the node:

To start animation player:

        // Start playback in animation player by sending PlayMessage
        // to the node where animation player is attached.
        AnimationPlayer::PlayMessageArguments playMessageArguments;
        playMessageArguments.setPlaybackMode(Timeline::DirectionBehaviorReverse);
        playMessageArguments.setDurationScale(2.0f);
        playMessageArguments.setRepeatCount(2);
        node->dispatchMessage(AnimationPlayer::PlayMessage, playMessageArguments);

To pause animation player:

        // Pause playback in animation player by sending PauseMessage
        // to the node where animation player is attached.
        AnimationPlayer::PauseMessageArguments pauseMessageArguments;
        node->dispatchMessage(AnimationPlayer::PauseMessage, pauseMessageArguments);

To resume animation player:

        // Resume playback in animation player by sending ResumeMessage
        // to the node where animation player is attached.
        AnimationPlayer::ResumeMessageArguments resumeMessageArguments;
        node->dispatchMessage(AnimationPlayer::ResumeMessage, resumeMessageArguments);

To stop animation player:

        // Stop playback in animation player by sending StopMessage
        // to the node where animation player is attached.
        AnimationPlayer::StopMessageArguments stopMessageArguments;
        node->dispatchMessage(AnimationPlayer::StopMessage, stopMessageArguments);

To detach animation player from the node:

Constructor & Destructor Documentation

AnimationPlayer()

kanzi::AnimationPlayer::AnimationPlayer ( Domain * domain, string_view name )

explicitprotected

Constructor.

Parameters

domain	Domain.
name	The name of the animation player.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::AnimationPlayer::makeEditorInfo ( )

static

Returns PropertyType editor info of animation player.

create()

static AnimationPlayerSharedPtr kanzi::AnimationPlayer::create ( Domain * domain, string_view name )

inlinestatic

Creates animation player.

Parameters

domain	Domain.
name	Name of animation player.

Returns

animation player.

setTimeline()

void kanzi::AnimationPlayer::setTimeline

(

TimelineSharedPtr

animationTimeline

)

Sets the TimelineProperty property of an Animation Player to the animation timeline that you pass in this method.

The Animation Player uses this timeline the next time it starts animation playback.

Parameters

animationTimeline

The animation timeline that you want to set to the Animation Player.

getTimeline()

TimelineSharedPtr kanzi::AnimationPlayer::getTimeline

(

)

const

Gets the animation timeline from the TimelineProperty property of an Animation Player.

Returns

The animation timeline of the Animation Player.

getTimelinePlayback()

TimelinePlaybackSharedPtr kanzi::AnimationPlayer::getTimelinePlayback

(

)

const

Gets the timeline playback made for the timeline.

Returns

Timeline playback. The return value can be null.

setAutoplayEnabled()

void kanzi::AnimationPlayer::setAutoplayEnabled

(

bool

enabled

)

Sets the value of the AutoplayEnabledProperty property of an Animation Player.

The Animation Player uses this value the next time you attach that Animation Player.

Parameters

enabled

If the Animation Player starts playback of its animation timeline on attach automatically, true, otherwise false.

isAutoplayEnabled()

bool kanzi::AnimationPlayer::isAutoplayEnabled

(

)

const

Gets the value of the AutoplayEnabledProperty property.

Returns

If the Animation Player starts the playback of its animation timeline on attach automatically, true, otherwise false.

setRelativePlayback()

void kanzi::AnimationPlayer::setRelativePlayback

(

bool

relativePlayback

)

Sets the value of the RelativePlaybackProperty property.

Parameters

relativePlayback

Specifies whether playback is relative.

isRelativePlayback()

bool kanzi::AnimationPlayer::isRelativePlayback

(

)

const

Gets the value of the RelativePlaybackProperty property.

Returns

If the playback is relative, true, otherwise false.

setRestoreOriginalValuesAfterPlayback()

void kanzi::AnimationPlayer::setRestoreOriginalValuesAfterPlayback

(

bool

restore

)

Sets the values of the RestoreOriginalValuesAfterPlaybackProperty property.

Parameters

restore

Specifies whether original values restored after playback finishes.

isRestoreOriginalValuesAfterPlayback()

bool kanzi::AnimationPlayer::isRestoreOriginalValuesAfterPlayback

(

)

const

Gets the values of the RestoreOriginalValuesAfterPlaybackProperty property.

Returns

If the original values are restored after playback finishes, true, otherwise false.

setPlaybackMode()

void kanzi::AnimationPlayer::setPlaybackMode

(

Timeline::DirectionBehavior

mode

)

Sets the value of the PlaybackModeProperty property.

Parameters

mode	Playback mode.

getPlaybackMode()

Timeline::DirectionBehavior kanzi::AnimationPlayer::getPlaybackMode

(

)

const

Gets the value of the PlaybackModeProperty property.

Returns

Playback mode.

setDurationScale()

void kanzi::AnimationPlayer::setDurationScale

(

float

durationScale

)

Sets the value of the DurationScaleProperty property.

Parameters

durationScale

Duration scale.

getDurationScale()

float kanzi::AnimationPlayer::getDurationScale

(

)

const

Gets the value of the DurationScaleProperty property.

Returns

Duration scale.

setRepeatCount()

void kanzi::AnimationPlayer::setRepeatCount

(

int

repeatCount

)

Sets the value of the RepeatCountProperty property.

Parameters

repeatCount

Repeat count.

getRepeatCount()

int kanzi::AnimationPlayer::getRepeatCount

(

)

const

Gets the value of the RepeatCountProperty property.

Returns

Repeat count.

start()

void kanzi::AnimationPlayer::start	(	Timeline::DirectionBehavior	direction,
		float	durationScale,
		unsigned int	repeatCount )

Starts a new playback from the state of any animation player.

Kanzi applies the parameters, which you pass to this function, as a whole on top of the property values that are set in the animation player. For example, if in the animation player the AnimationPlayer::PlaybackModeProperty property is set to Timeline::DirectionBehaviorNormal and the AnimationPlayer::RepeatCountProperty property is set to 2, and you call this function with the direction parameter set to Timeline::DirectionBehaviorPingPong, the animation player plays its timeline first twice normally and then twice in reverse.

Parameters

direction	The playback mode that you want to apply on top of the value of the AnimationPlayer::PlaybackModeProperty property.
durationScale	The duration scale that you want to apply on top of the value of the AnimationPlayer::DurationScaleProperty property.
repeatCount	The repeat count that you want to apply on top of the value of the AnimationPlayer::RepeatCountProperty property.

resume()

void kanzi::AnimationPlayer::resume

(

)

Resumes playing a paused timeline. If the playback is stopped, starts playing the timeline from the beginning.

pause()

void kanzi::AnimationPlayer::pause

(

)

Pauses running playback. If the playback is already paused or stopped, does nothing.

stop()

void kanzi::AnimationPlayer::stop

(

)

Stops running or paused playback.

If the playback is already stopped, does nothing. To start a new playback after stopping the playback, call start() or resume().

attachOverride()

void kanzi::AnimationPlayer::attachOverride ( )

overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

detachOverride()

void kanzi::AnimationPlayer::detachOverride ( )

overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

playMessageHandler()

void kanzi::AnimationPlayer::playMessageHandler ( PlayMessageArguments & messageArguments )

protected

Message handler for the PlayMessage message.

Parameters

messageArguments

Arguments of Play message.

resumeMessageHandler()

void kanzi::AnimationPlayer::resumeMessageHandler ( ResumeMessageArguments & messageArguments )

protected

Message handler for the ResumeMessage message.

Parameters

messageArguments

Arguments of Resume message.

pauseMessageHandler()

void kanzi::AnimationPlayer::pauseMessageHandler ( PauseMessageArguments & messageArguments )

protected

Message handler for the PauseMessage message.

Parameters

messageArguments

Arguments of pause message.

stopMessageHandler()

void kanzi::AnimationPlayer::stopMessageHandler ( StopMessageArguments & messageArguments )

protected

Message handler for the StopMessage message.

Parameters

messageArguments

Arguments of Stop message.

onPlaybackFinished()

void kanzi::AnimationPlayer::onPlaybackFinished ( TimelinePlayback & timelinePlayback )

protected

Handler for finish timeline playback.

Parameters

timelinePlayback

Finished playback.

Member Data Documentation

TimelineProperty

PropertyType<ResourceSharedPtr> kanzi::AnimationPlayer::TimelineProperty

static

Sets the animation timeline that an Animation Player plays after you attach it.

AutoplayEnabledProperty

PropertyType<bool> kanzi::AnimationPlayer::AutoplayEnabledProperty

static

Sets whether an Animation Player starts the playback of its animation timeline immediately after the player is attached to a node which is attached to the node tree.

By default, autoplay is disabled.

RelativePlaybackProperty

PropertyType<bool> kanzi::AnimationPlayer::RelativePlaybackProperty

static

Sets whether an Animation Player plays animation timelines in a relative manner by adding the animated value to the target property value instead of replacing the property value.

By default, relative playback is disabled.

RestoreOriginalValuesAfterPlaybackProperty

PropertyType<bool> kanzi::AnimationPlayer::RestoreOriginalValuesAfterPlaybackProperty

static

Sets whether animated properties return to their initial values after the playback of an animation timeline ends.

By default, this is disabled.

PlaybackModeProperty

PropertyType<KzuTimeLineEntryPlaybackMode> kanzi::AnimationPlayer::PlaybackModeProperty

static

Sets the mode of an animation timeline playback to either:

• Normal plays the animation timeline normally from the start to end. This is the default value.
• Reverse plays the animation timeline in reverse from the end to start.
• Ping pong plays the animation timeline first normally, then in reverse.

DurationScaleProperty

PropertyType<float> kanzi::AnimationPlayer::DurationScaleProperty

static

Sets the amount by which the duration of an animation timeline is scaled during its playback.

For example:

• When set to 1.0, the animation is of the same length as it is defined in the animation. This is the default value.
• When set to 0.5, the animation is half as long as it is defined in the animation.
• When set to 2.0, the animation is twice as long as it is defined in the animation.

RepeatCountProperty

PropertyType<int> kanzi::AnimationPlayer::RepeatCountProperty

static

Sets how many times an animation timeline is played during its playback.

The default value is 1.

PlayMessage

MessageType<PlayMessageArguments> kanzi::AnimationPlayer::PlayMessage

static

Play message.

When you send this message to a node to which an Animation Player is attached, that Animation Player starts to play the animation timeline set in its TimelineProperty property. When you send the Play message to an Animation Player that is playing back an animation timeline, the Animation Player stops that playback and starts a new playback.

ResumeMessage

MessageType<ResumeMessageArguments> kanzi::AnimationPlayer::ResumeMessage

static

Resume message.

When you send this message to the node to which an animation player is attached, the animation player starts to play the animation timeline set in its TimelineProperty property. If the animation player has paused a playback, it resumes playing it.

PauseMessage

MessageType<PauseMessageArguments> kanzi::AnimationPlayer::PauseMessage

static

Pause message.

When you send this message to the node to which an animation player is attached, the animation player pauses the current playback. If the playback is paused of stopped, the animation player does nothing.

StopMessage

MessageType<StopMessageArguments> kanzi::AnimationPlayer::StopMessage

static

Stop message.

When you send this message to the node to which an animation player is attached, the animation player stops the playback. The next PlayMessage message starts to play the animation timeline from the beginning.

StartedMessage

MessageType<StartedMessageArguments> kanzi::AnimationPlayer::StartedMessage

static

Started message.

When the animation player starts the playback of its timeline, it dispatches the Started message. The animation player does not dispatch this message when it resumes playback after it was paused. After this message is sent the timeline is actively applied to animate the target properties.

StoppedMessage

MessageType<StoppedMessageArguments> kanzi::AnimationPlayer::StoppedMessage

static

Stopped message.

When the animation player stops the playback of its timeline, it dispatches the Stopped message. After this message is sent the timeline is not applied to the target properties.

CompletedMessage

MessageType<CompletedMessageArguments> kanzi::AnimationPlayer::CompletedMessage

static

Completed message.

When the animation player completes the playback of its timeline, it dispatches the Completed message. After this message is sent the timeline is still applied to the target properties.

---

The documentation for this class was generated from the following file:

• kanzi/ui/node_component/animation/animation_player.hpp